home *** CD-ROM | disk | FTP | other *** search
/ Network PC / Network PC.iso / amiga utilities / disk utilities / compression / xfd1.13 / developper / autodoc / applications.doc next >
Encoding:
Text File  |  1997-11-21  |  5.1 KB  |  113 lines
  1.  
  2.                      Using XFD In Own Applications
  3.                      -----------------------------
  4.  
  5. This guide describes the usual way how to use xfdmaster.library from your
  6. own applications. Read the autodocs for further information.
  7.  
  8. If you want to decrunch files from a buffer, do it like this:
  9.  
  10. 1.  Call xfdAllocObject() with XFDOBJ_BUFFERINFO (V36). If not successful,
  11.     go on with 12.
  12. 2.  Get file size, allocate buffer with that size and load file to buffer.
  13.     If not successful, go on with 10.
  14. 3.  Call xfdRecogBuffer() with xfdbi_SourceBuffer and xfdbi_SourceBufLen
  15.     initialized. You may also specify some flags in xfdbi_Flags (V37).
  16.     If not successful, file is not crunched and you may work with that
  17.     file as it is, release the used memory and go on with 10.
  18. 4.  Check xfdbi_PackerFlags for XFDPFB_PASSWORD or XFDPFB_KEY16/32 (V35),
  19.     go on with 6. if not set.
  20. 5.  Get password (maximum length is stored in xfdbi_MaxSpecialLen) or
  21.     the required 16/32 bit key and store a pointer to it in xfdbi_Special.
  22.     If xfdbi_MaxSpecialLen is -1 then password length is not limited.
  23. 6.  Initialize xfdbi_TargetBufMemType and call xfdDecrunchBuffer(). If not
  24.     successful, work with crunched file, release memory afterwards and
  25.     go on with 10.
  26. 7.  Release memory of xfdbi_SourceBuffer.
  27. 8.  Work with decrunched file.
  28. 9.  Release memory of xfdbi_TargetBuffer.
  29. 10. If you have another file to decrunch, step back to 2.
  30. 11. Call xfdFreeObject() (V36).
  31. 12. Exit!
  32.  
  33. If you want to decrunch a segment list, do it like this:
  34.  
  35. 1.  Call xfdAllocObject() with XFDOBJ_SEGMENTINFO (V36). If not successful,
  36.     go on with 11.
  37. 2.  dos.library/LoadSeg() file. If not successful, go on with 9.
  38. 3.  Call xfdRecogSegment() with xfdsi_SegList and optional xfdsi_Flags (V37)
  39.     initialized. If not successful, seglist isn't crunched and you may go
  40.     on with 7.
  41. 4.  Check xfdsi_PackerFlags for XFDPFB_PASSWORD or XFDPFB_KEY16/32 (V35).
  42.     If set, get password (maximum length is stored in xfdsi_MaxSpecialLen)
  43.     or 16/32 bit key and store a pointer to it in xfdsi_Special.
  44.     If xfdsi_MaxSpecialLen is -1 then password length is not limited.
  45. 5.  (V34) Check xfdsi_PackerFlags for XFDPFB_RELMODE. If set, init
  46.     xfdsi_RelMode with the desired value.
  47. 6.  Call xfdDecrunchSegment(). If not successful, test xfdsi_SegList.
  48.     If this field contains NULL, no seglist is available anymore. You
  49.     have to dos.library/LoadSeg() the file again then.
  50. 7.  Work with segment list.
  51. 8.  dos.library/UnloadSeg() segment list.
  52. 9.  If you have another segment list to decrunch, step back to 2.
  53. 10. Call xfdFreeObject() (V36).
  54. 11. Exit!
  55.  
  56. If you only want to test if one or more files are crunched without
  57. decrunching it afterwards, here's a way to do this:
  58.  
  59. 1.  Call xfdAllocObject() with XFDOBJ_BUFFERINFO (V36). If not successful,
  60.     go on with 9.
  61. 2.  Get minimum buffer size for recognition from xfdm_MinBufferSize (V36),
  62.     allocate buffer with that size and initialize xfdbi_SourceBuffer
  63.     and xfdbi_SourceBufLen. On error goto 8.
  64. 3.  Read as many bytes from the file as fit in xfdbi_SourceBuffer.
  65.     If file is shorter than xfdm_MinBufferSize, set real length in
  66.     xfdbi_SourceBufLen. If reading fails, goto 6.
  67. 4.  Call xfdRecogBuffer(). If not successful, file is not crunched.
  68.     Go on with 6 then.
  69. 5.  Print information about cruncher or something similar.
  70. 6.  If you have another file to test, step back to 3.
  71. 7.  Release memory of xfdbi_SourceBuffer.
  72. 8.  Call xfdFreeObject() (V36).
  73. 9.  Exit!
  74.  
  75. If you want to unlink two files, do it like this:
  76.  
  77. 1.  Call xfdAllocObject() with XFDOBJ_LINKERINFO (V36). If not successful,
  78.     go on with 9.
  79. 2.  Get file size, allocate buffer with that size and load file to buffer.
  80.     If not successful, go on with 7.
  81. 3.  Call xfdRecogLinker() with xfdli_Buffer and xfdli_BufLen initialized.
  82.     If not successful, file is not linked. Go on with 6 then.
  83. 4.  Call xfdUnlink(). If not successful, go on with 6.
  84. 5.  Do something with unlinked files.
  85. 6.  Release memory of xfdli_Buffer.
  86. 7.  If you have another file to unlink, step back to 2.
  87. 8.  Call xfdFreeObject() (V36).
  88. 9.  Exit!
  89.  
  90. If you only want to test if a file is a linked one without unlinking
  91. it afterwards, here's a way to do this:
  92.  
  93. 1.  Call xfdAllocObject() with XFDOBJ_LINKERINFO (V36). If not successful,
  94.     go on with 9.
  95. 2.  Get minimum buffer size for recognition from xfdm_MinLinkerSize (V36),
  96.     allocate buffer with that size and initialize xfdli_Buffer and
  97.     xfdli_BufLen. On error goto 8.
  98. 3.  Read as many bytes from the file as fit in xfdli_Buffer.
  99.     If file is shorter than xfdm_MinLinkerSize, set real length in
  100.     xfdli_BufLen. If reading fails, goto 6.
  101. 4.  Call xfdRecogLinker(). If not successful, file is not linked.
  102.     Go on with 6 then.
  103. 5.  Print information about linker or something similar.
  104. 6.  If you have another file to test, step back to 3.
  105. 7.  Release memory of xfdli_Buffer.
  106. 8.  Call xfdFreeObject() (V36).
  107. 9.  Exit!
  108.  
  109. Whenever you intend to use a feature of the xfdmaster.library that is
  110. marked (V34) or higher, make sure that you use this version number
  111. during the exec.library/OpenLibrary() call. Otherwise, if you try to
  112. use new features with an old library version, the system might crash.
  113.